home *** CD-ROM | disk | FTP | other *** search
XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) NNNNAAAAMMMMEEEE XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy - A clipboard function that sets up a storage and data structure SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>> ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////CCCCuuuuttttPPPPaaaasssstttteeee....hhhh>>>> iiiinnnntttt XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy ((((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _c_l_i_p__l_a_b_e_l, _t_i_m_e_s_t_a_m_p, _w_i_d_g_e_t, _c_a_l_l_b_a_c_k, _i_t_e_m__i_d)))) DDDDiiiissssppppllllaaaayyyy * _d_i_s_p_l_a_y;;;; WWWWiiiinnnnddddoooowwww _w_i_n_d_o_w;;;; XXXXmmmmSSSSttttrrrriiiinnnngggg _c_l_i_p__l_a_b_e_l;;;; TTTTiiiimmmmeeee _t_i_m_e_s_t_a_m_p;;;; WWWWiiiiddddggggeeeetttt _w_i_d_g_e_t;;;; XXXXmmmmCCCCuuuuttttPPPPaaaasssstttteeeePPPPrrrroooocccc_c_a_l_l_b_a_c_k;;;; lllloooonnnngggg * _i_t_e_m__i_d;;;; VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents version 1.2 of the Motif library. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy sets up storage and data structures to receive clipboard data. An application calls this function during a cut or copy operation. The data item that these structures receive then becomes the next data item in the clipboard. Copying a large piece of data to the clipboard can take a long time. It is possible that, once copied, no application will ever request that data. The Motif Toolkit provides a mechanism so that an application does not need to actually pass data to the clipboard until the data has been requested by some application. Instead, the application passes format and length information in XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy to the clipboard functions, along with a widget ID and a callback function address that is passed in XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy. The widget ID is needed for communications between the clipboard functions in the application that owns the data and the clipboard functions in the application that requests the data. The callback functions are responsible for copying the actual data to the clipboard via XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyyBBBByyyyNNNNaaaammmmeeee. The callback function is also called if the data item is removed from the clipboard, and the actual data is therefore no longer needed. _d_i_s_p_l_a_y Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure Page 1 (printed 4/30/98) XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) that was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or XXXXttttDDDDiiiissssppppllllaaaayyyy. _w_i_n_d_o_w Specifies a widget's window ID that relates the application window to the clipboard. The widget's window ID can be obtained by using XXXXttttWWWWiiiinnnnddddoooowwww. The same application instance should pass the same window ID to each of the clipboard functions that it calls. _c_l_i_p__l_a_b_e_l Specifies the label to be associated with the data item. This argument is used to identify the data item, for example, in a clipboard viewer. An example of a label is the name of the application that places the data in the clipboard. _t_i_m_e_s_t_a_m_p Specifies the time of the event that triggered the copy. A valid timestamp must be supplied; it is not sufficient to use CCCCuuuurrrrrrrreeeennnnttttTTTTiiiimmmmeeee. _w_i_d_g_e_t Specifies the ID of the widget that receives messages requesting data previously passed by name. This argument must be present in order to pass data by name. Any valid widget ID in your application can be used for this purpose and all the message handling is taken care of by the cut and paste functions. _c_a_l_l_b_a_c_k Specifies the address of the callback function that is called when the clipboard needs data that was originally passed by name. This is also the callback to receive the ddddeeeelllleeeetttteeee message for items that were originally passed by name. This argument must be present in order to pass data by name. _i_t_e_m__i_d Specifies the number assigned to this data item. The application uses this number in calls to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy, XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy, and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy. For more information on passing data by name, see XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX)))) and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyyBBBByyyyNNNNaaaammmmeeee((((3333XXXX)))). The _w_i_d_g_e_t and _c_a_l_l_b_a_c_k arguments must be present in order to pass data by name. The callback format is as follows: vvvvooooiiiidddd ((((****_c_a_l_l_b_a_c_k) ((((_w_i_d_g_e_t, _d_a_t_a__i_d, _p_r_i_v_a_t_e, _r_e_a_s_o_n)))) WWWWiiiiddddggggeeeetttt _w_i_d_g_e_t;;;; iiiinnnntttt ****_d_a_t_a__i_d;;;; Page 2 (printed 4/30/98) XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))) iiiinnnntttt ****_p_r_i_v_a_t_e;;;; iiiinnnntttt ****_r_e_a_s_o_n;;;; _w_i_d_g_e_t Specifies the ID of the widget passed to this function. _d_a_t_a__i_d Specifies the identifying number returned by XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy, which identifies the pass-by- name data. _p_r_i_v_a_t_e Specifies the private information passed to XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy. _r_e_a_s_o_n Specifies the reason, which is either XXXXmmmmCCCCRRRR____CCCCLLLLIIIIPPPPBBBBOOOOAAAARRRRDDDD____DDDDAAAATTTTAAAA____DDDDEEEELLLLEEEETTTTEEEE or XXXXmmmmCCCCRRRR____CCCCLLLLIIIIPPPPBBBBOOOOAAAARRRRDDDD____DDDDAAAATTTTAAAA____RRRREEEEQQQQUUUUEEEESSSSTTTT. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE CCCClllliiiippppbbbbooooaaaarrrrddddSSSSuuuucccccccceeeessssssss The function is successful. CCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkkeeeedddd The function failed because the clipboard was locked by another application. The application can continue to call the function again with the same parameters until the lock goes away. This gives the application the opportunity to ask if the user wants to keep trying or to give up on the operation. RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyyBBBByyyyNNNNaaaammmmeeee((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeCCCCoooouuuunnnntttt((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeLLLLeeeennnnggggtttthhhh((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnddddooooCCCCooooppppyyyy((((3333XXXX)))), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnlllloooocccckkkk((((3333XXXX)))), and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddWWWWiiiitttthhhhddddrrrraaaawwwwFFFFoooorrrrmmmmaaaatttt((((3333XXXX)))). Page 3 (printed 4/30/98) 
